Collapse multi-line @param / @return descriptions onto single lines#46
Merged
Conversation
turegjorup
force-pushed
the
feature/phpdoc-align-left
branch
from
d98fc27 to
7906138
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #46 +/- ##
===========================================
Coverage 100.00% 100.00%
Complexity 71 71
===========================================
Files 1 1
Lines 185 185
===========================================
Hits 185 185
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
A few docblocks in `OpenIdConfigurationProvider` and the test suite
had their descriptions wrapped onto a continuation `*` line:
* @param int $length
* Length of the random string to be generated
*
* @return string
* The generated state
The `phpdoc_align: vertical` rule from the @symfony preset doesn't
create those wraps — it just aligns whatever multi-line structure
exists in the source. Flattening each description back onto its
`@param` / `@return` line lets the rule pad the columns into a
tidy table instead:
* @param int $length Length of the random string to be generated
* @return string The generated state
No `.php-cs-fixer.dist.php` change: the @symfony default produces
the clean form once the source isn't pre-wrapped.
Also consolidates two `### Documentation` subsections under
`[Unreleased]` (left over from PR #44) into one — markdownlint's
MD024 was flagging the duplicate heading.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
turegjorup
force-pushed
the
feature/phpdoc-align-left
branch
from
7906138 to
716bcfa
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Dedicated follow-up stacked on top of PR #45 (PR C). A few docblocks in
OpenIdConfigurationProviderand the test suite had their@param/@returndescriptions wrapped onto a continuation*line:The
phpdoc_align: verticalrule from the @symfony preset doesn't create those wraps — it just aligns whatever multi-line structure already exists in the source. The wrap was a best-effort output of an earlier auto-format pass, not a deliberate style choice.Flattening each description back onto its tag line lets the @symfony rule pad the columns into a tidy aligned table instead:
No
.php-cs-fixer.dist.phpchange — the @symfony default produces the clean output once the source isn't pre-wrapped. Future single-line tags stay single-line under the same rule.Also in this PR
Consolidates two
### Documentationsubsections under[Unreleased](left over from PR #44) into one.markdownlint's MD024 was flagging the duplicate heading.Test plan
task lint:php— clean (phpdoc_align: verticalaccepts the flattened form).task lint:markdown— clean (no duplicate-heading warning).task test:coverage— 100% onOpenIdConfigurationProvider(24/24 methods, 161/161 lines).task analyze:php— no errors.Base
Targets
feature/phpstan-max-completion(PR #45). When PR #45 merges to develop, this PR auto-retargets.🤖 Generated with Claude Code